IApi.GetAxisByIndex method

Gets information from an axis.

Assembly: IntervalZero.KINGSTAR.Base.Api (in IntervalZero.KINGSTAR.Base.dll) Version: 4.4.0.0

Syntax

KsReturn<AxisDetails> GetAxisByIndex(
       int Index
)

Function GetAxisByIndex(
       Index As Integer
) As KsReturn(Of AxisDetails)

Parameters

Index

Type: int

The index of an axis. Indexes are zero based. Aliases affect this parameter.

Return value

Returns a KsError code and an AxisDetails value.

Remarks

Gets the axis and its encoder resolution details. Used after the KINGSTAR Subsystem is started.

Usable EtherCAT states

ecatOP

Examples

N/A